<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.shading</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;shading
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.shading-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module shading</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_accuracy" class="summary-sig-name">set_accuracy</a>(<span class="summary-sig-arg">accuracy</span>)</span><br />
      Sets the accuracy of the overshadowing calculation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_accuracy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_angles" class="summary-sig-name">get_angles</a>()</span><br />
      Retrieves the currently set angles of azimuth and altitude for 
      shading mask calculations, which determines the resolution of the sky
      dome sections used.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_angles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_angles" class="summary-sig-name">set_angles</a>(<span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Sets the angles of azimuth and altitude for shading mask calculations
      which determine the resolutions of the sky dome sections used.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_angles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_both_sides" class="summary-sig-name">get_both_sides</a>()</span><br />
      Returns a boolean value indicating if shading is calculated for both 
      sides of the selected object 1, or only the direction of the surface 
      normal 0.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_both_sides">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_both_sides" class="summary-sig-name">set_both_sides</a>(<span class="summary-sig-arg">state</span>)</span><br />
      Sets whether shading is calculated over both sides of the selected 
      object or only the direction of the surface normal.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_both_sides">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_sky_components" class="summary-sig-name">get_sky_components</a>()</span><br />
      Returns the three sky components calculated from the current shading 
      mask.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_sky_components">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_diffuse" class="summary-sig-name">get_diffuse</a>()</span><br />
      Returns the diffuse solar radiation component as a single decimal 
      value in Watts per square metre.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_diffuse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_direct" class="summary-sig-name">get_direct</a>()</span><br />
      Returns the current direct solar radiation component as a single 
      decimal value in Watts per square metre.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_direct">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_direct_only" class="summary-sig-name">get_direct_only</a>()</span><br />
      Returns a boolean value indicating if direct sunlight only is to be 
      calclated.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_direct_only">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_direct_only" class="summary-sig-name">set_direct_only</a>(<span class="summary-sig-arg">state</span>)</span><br />
      Sets whether direct sunlight only is to be calclated..</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_direct_only">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_percentage" class="summary-sig-name">get_percentage</a>()</span><br />
      Returns the percentage-in-shade of the selected object as a single 
      decimal percentage value, using the current model date and time 
      settings.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_percentage_angle" class="summary-sig-name">get_percentage_angle</a>(<span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Returns the percentage-in-shade of the selected object as a single 
      decimal percentage value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_angle">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_percentage_date_time" class="summary-sig-name">get_percentage_date_time</a>(<span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Returns the percentage-in-shade of the selected object as a single 
      decimal percentage value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_date_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_percentage_index" class="summary-sig-name">get_percentage_index</a>(<span class="summary-sig-arg">x</span>,
        <span class="summary-sig-arg">y</span>)</span><br />
      Returns the percentage-in-shade of the selected object as a single 
      decimal value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_range" class="summary-sig-name">get_range</a>(<span class="summary-sig-arg">fromDay</span>,
        <span class="summary-sig-arg">toDay</span>)</span><br />
      Returns the total direct and diffuse incident solar radiation on the 
      object for which the current shading mask has been calculated.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_range">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_rays" class="summary-sig-name">get_rays</a>()</span><br />
      Retrieves the current setting of whether to display shading rays 
      during the shading calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_rays">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_rays" class="summary-sig-name">set_rays</a>(<span class="summary-sig-arg">state</span>)</span><br />
      Sets whether to display shading rays during the shading calculations.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_rays">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#sky_component" class="summary-sig-name">sky_component</a>()</span><br />
      Returns the percentage of CIE Overcast Sky illumination visible from 
      the selected surface.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#sky_component">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#get_update" class="summary-sig-name">get_update</a>()</span><br />
      Returns a boolean value indicating the status of an object's shading 
      mask.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.shading-module.html#set_update" class="summary-sig-name">set_update</a>(<span class="summary-sig-arg">state</span>)</span><br />
      Sets which shading mask to use for the selected object - it's own 
      mid-accuracy mask, or a detailed shading mask calculated using the 
      calc.shading.percentage command.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="set_accuracy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_accuracy</span>(<span class="sig-arg">accuracy</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_accuracy">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the accuracy of the overshadowing calculation. This calculation 
  is done by dividing each surface into a grid, generating a random point 
  within each grid square and then checking the in-shade status of each 
  point.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>accuracy An integer value or token corresponding to the following 
  Shading Accuracy table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Shading Accuracy Token Value Description full 0 Break object into 
  25x25 grid. high 1 Break object into 10x10 grid. medium 2 Break object 
  into 5x5 grid. low 3 Use single point at object centre.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_angles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_angles</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_angles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the currently set angles of azimuth and altitude for shading
  mask calculations, which determines the resolution of the sky dome 
  sections used.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>azi The azimuth angle in degrees.</p>
  <p>alt The altitude angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_angles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_angles</span>(<span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_angles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the angles of azimuth and altitude for shading mask calculations 
  which determine the resolutions of the sky dome sections used.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>azi The azimuth value in degrees.</p>
  <p>alt The altitude value in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_both_sides"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_both_sides</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_both_sides">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a boolean value indicating if shading is calculated for both 
  sides of the selected object 1, or only the direction of the surface 
  normal 0.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value determining if shading is calculated for both 
  sides for the selected object. This is a boolean value where 1 is set and
  0 means unset.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_both_sides"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_both_sides</span>(<span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_both_sides">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets whether shading is calculated over both sides of the selected 
  object or only the direction of the surface normal.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>state Determines if shading is calculated for both sides for the 
  selected object. This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sky_components"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sky_components</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_sky_components">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the three sky components calculated from the current shading 
  mask. The first two values are the fraction of the sky 
  illuminance/radiation visible to the selected object for which the mask 
  was calculated, under CIE overcast and uniform sky conditions. The third 
  result is only valid for vertical surfaces and is the Vertical Sky 
  Component as defined by the Building Research Establishment. These are 
  the values displayed within the bottom right corner of the SunPath 
  diagram when the shading mask is displayed.</p>
  <p>If the shading calculation has not yet been performed (see the 
  calc.shading.percentage method), this method will carry one out for the 
  current object.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>overcast A decimal value containing the overcast sky component.</p>
  <p>uniform A decimal value containing the uniform sky component.</p>
  <p>vertical A decimal value containing the vertical sky component.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_diffuse"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_diffuse</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_diffuse">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the diffuse solar radiation component as a single decimal 
  value in Watts per square metre. This is only valid after a shading 
  calculation has been performed (see the calc.shading.percentage method 
  and set.model.time properties for mroe information).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the current diffuse solar 
  component.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_direct"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_direct</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_direct">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the current direct solar radiation component as a single 
  decimal value in Watts per square metre. This is only valid after a 
  shading calculation has been performed (see the calc.shading.percentage 
  method and set.model.time properties for more information).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the current direct solar 
  component.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_direct_only"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_direct_only</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_direct_only">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a boolean value indicating if direct sunlight only is to be 
  calclated.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value determining if direct sunlight only is to be 
  calclated. This is a boolean value where 1 is set and 0 means unset.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_direct_only"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_direct_only</span>(<span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_direct_only">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets whether direct sunlight only is to be calclated..</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>state Determines if direct sunlight only is to be calclated. This is a
  boolean value where 1 or true represents the affirmative and 0 or false 
  the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the selected object as a single 
  decimal percentage value, using the current model date and time 
  settings.</p>
  <p>This is only valid after a shading calculation has been performed (see
  the calc.shading.percentage method and set.model.time properties for more
  information). If a negative value is returned, then the 
  set.shading.bothsides option has been used and the point is behind the 
  surface.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the shading value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_angle"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_angle</span>(<span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_angle">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the selected object as a single 
  decimal percentage value. Note that this is only valid after a shading 
  calculation has been performed (see the calc.shading.percentage method 
  and set.model.time properties for more information).</p>
  <p>If a negative value is returned, then the set.shading.bothsides option
  has been used and the point is behind the surface.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>azi The azimuth (-180 deg to 180 deg) angle representing, together 
  with the altitude angle, a point in the sky from which to retrieve the 
  value.</p>
  <p>To retrieve the sun position at any time, use the get.model.sunangles 
  command.</p>
  <p>alt The altitude (0 deg to 90 deg) angle representing, together with 
  the azimuth angle, a point in the sky from which to retrieve the 
  value.</p>
  <p>To retrieve the sun position at any time, use the get.model.sunangles 
  command.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the shading value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_date_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_date_time</span>(<span class="sig-arg">day</span>,
        <span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_date_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the selected object as a single 
  decimal percentage value. This is only valid after a shading calculation 
  has been performed (see the calc.shading.percentage method and 
  set.model.time properties for more information).</p>
  <p>If a negative value is returned, then the set.shading.bothsides option
  has been used and the point is behind the surface.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>day The day of the year from which to return the percentage (1 to 
  365).</p>
  <p>time The time of the day from which to return the percentage (0 to 
  23).</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the shading value</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_percentage_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_percentage_index</span>(<span class="sig-arg">x</span>,
        <span class="sig-arg">y</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_percentage_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage-in-shade of the selected object as a single 
  decimal value. Note that this is only valid after a shading calculation 
  has been performed (see the calc.shading.percentage method and 
  set.model.time properties for more information).</p>
  <p>If a negative value is returned, then the set.shading.bothsides option
  has been used and the point is behind the surface.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>x The X index of the shading table, where X is the azimuth angle 
  increment set in the set.shading.angles property.</p>
  <p>y The Y index of the shading table, where Y is the altitude angle 
  increment set in the set.shading.angles property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the shading value.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_range"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_range</span>(<span class="sig-arg">fromDay</span>,
        <span class="sig-arg">toDay</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_range">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the total direct and diffuse incident solar radiation on the 
  object for which the current shading mask has been calculated. Both are 
  returned as single decimal values in Watts per square metre. A third 
  value is also returned, being a count of the number of hours over which 
  the direct and diffuse values were generated.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>fromDay A value representing the Julian date when the calculation will
  begin, given as an integer from 1 to 365.</p>
  <p>toDay A value representing the Julian date when the calculation will 
  end, given as an integer from 1 to 365.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>totalDirect A decimal value containing the totel direct solar 
  component.</p>
  <p>totalDiffuse A decimal value containing the total diffuse solar 
  component.</p>
  <p>totalHours A decimal value containing the total sunlight hours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_rays"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_rays</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_rays">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current setting of whether to display shading rays 
  during the shading calculations.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value determining if rays are shown or not. This is a 
  boolean value where 1 is set and 0 means unset.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_rays"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_rays</span>(<span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_rays">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets whether to display shading rays during the shading 
  calculations.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>state Set the display of shading rays. This is a boolean value where 1
  or true represents the affirmative and 0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="sky_component"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sky_component</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#sky_component">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the percentage of CIE Overcast Sky illumination visible from 
  the selected surface. This is time-independent and only valid after a 
  shading calculation has been performed (see the calc.shading.percentage 
  method).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>SC A decimal value containing the sky component.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_update</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#get_update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a boolean value indicating the status of an object's shading 
  mask. A value of 0 indicates the object is using its own mid-accuracy 
  mask. A value of 1 indicates the object is using a detailed shading mask 
  calculated using the calc.shading.percentage command.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value determining what mask is used. This is a boolean
  value where 1 means a detailed mask and 0 it's own mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_update</span>(<span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.shading-pysrc.html#set_update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets which shading mask to use for the selected object - it's own 
  mid-accuracy mask, or a detailed shading mask calculated using the 
  calc.shading.percentage command.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>state This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative. If true, the detailed shading 
  mask overrides the selected object's own shading mask.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
